Skip to content

Databricks oauth docs#1676

Merged
Alek99 merged 5 commits intomainfrom
databricks-oauth-docs
Oct 27, 2025
Merged

Databricks oauth docs#1676
Alek99 merged 5 commits intomainfrom
databricks-oauth-docs

Conversation

@tgberkeley
Copy link
Copy Markdown
Collaborator

No description provided.

ElijahAhianyo and others added 5 commits October 27, 2025 12:56
* Revert "Fix: Remove interactive flag from deploy workflows (#1307)"

This reverts commit 08d1ce0bc34058c489ac580ffde194cfcc45b4ac.

* Revert "Fix: Replace --no-interactive with --interactive=false in deploy workflows (#1306)"

This reverts commit 55aed9660525cdd3b477a26141ab176640590a7b.

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Overview

Greptile Summary

Added comprehensive OAuth authentication documentation for Databricks integration as an alternative to Personal Access Token authentication. The PR includes 7 new screenshots walking through the Service Principal creation process in Databricks and restructures the documentation with tabs to present both authentication methods.

Key Changes:

  • Reorganized credentials section to present Personal Access Token and OAuth as two authentication options using markdown tabs
  • Added detailed step-by-step OAuth setup guide with 7 screenshots covering Service Principal creation, secret generation, and credential retrieval
  • Moved catalog/schema configuration before authentication credentials for better logical flow

Issue Found:

  • Step 2 (Configure the Integration) only lists DATABRICKS_TOKEN and doesn't mention the OAuth credentials (DATABRICKS_CLIENT_ID and DATABRICKS_CLIENT_SECRET) that users who chose OAuth would need to paste

Confidence Score: 3/5

  • This PR is safe to merge but has incomplete documentation that will confuse OAuth users
  • Documentation and image additions are non-breaking, but the missing OAuth credentials in Step 2 creates an incomplete user experience that needs to be addressed before users can successfully configure OAuth authentication
  • docs/ai_builder/integrations/databricks.md requires updating Step 2 to include OAuth credentials

Important Files Changed

File Analysis

Filename Score Overview
docs/ai_builder/integrations/databricks.md 3/5 Added OAuth authentication option with step-by-step guide, but Step 2 configuration section doesn't mention OAuth credentials

Sequence Diagram

sequenceDiagram
    participant User
    participant Docs as Documentation
    participant Databricks as Databricks UI
    participant App as Reflex App
    
    User->>Docs: View Databricks integration guide
    Docs->>User: Show authentication options (PAT or OAuth)
    
    alt Personal Access Token
        User->>Databricks: Navigate to Settings > Developer
        Databricks->>User: Show Access Tokens page
        User->>Databricks: Generate new token
        Databricks->>User: Return DATABRICKS_TOKEN
    else OAuth (New in this PR)
        User->>Databricks: Navigate to Manage Account
        User->>Databricks: Go to Users and Groups > Service Principals
        User->>Databricks: Add Service Principal
        Databricks->>User: Create Service Principal
        User->>Databricks: Generate OAuth secret
        Databricks->>User: Return DATABRICKS_CLIENT_ID and DATABRICKS_CLIENT_SECRET
    end
    
    User->>Databricks: Get HOST, WAREHOUSE_ID, CATALOG, SCHEMA
    Databricks->>User: Return connection details
    User->>App: Configure integration with credentials
    App->>Databricks: Validate connection
    Databricks->>App: Connection confirmed
    App->>User: Integration ready
Loading

Additional Comments (1)

  1. docs/ai_builder/integrations/databricks.md, line 252-258 (link)

    logic: Step 2 doesn't mention OAuth credentials. Users who chose OAuth need to paste DATABRICKS_CLIENT_ID and DATABRICKS_CLIENT_SECRET instead of DATABRICKS_TOKEN.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@Alek99 Alek99 self-requested a review October 27, 2025 23:35
@Alek99 Alek99 merged commit e02b579 into main Oct 27, 2025
10 checks passed
@Alek99 Alek99 deleted the databricks-oauth-docs branch October 27, 2025 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants